The Apama Extension for Visual Studio Code

Using a modern development environment like Visual Studio Code (VS Code) is one of the most convenient and efficient ways to build Apama applications. There is a community-maintained Apama Extension for VS Code which provides many features to speed up your Apama development.

When the latest fix of this version of Apama is used with the latest version of the extension, available features include:

  • Syntax highlighting.
  • Error/warning messages in the Problems view.
  • Easy insertion of common EPL code snippets - e.g. start typing monitor, event or for and you will be prompted to automatically insert the boilerplate code for a new monitor, event declaration or for loop.
  • Creating an “Apama project”, and adding bundles to it from the Apama Projects view or the command palette. This can be used for both product EPL/connectivity bundles and custom bundles such as the Analytics Builder Block SDK.
  • “Go to definition” of EPL events, actions and fields, for example by clicking while holding Ctrl. Not currently supported for local variables.
  • Hover information for EPL events, actions and fields, showing documentation if an ApamaDoc /** ... */ comment is present. Not currently supported for local variables.
  • Displaying EPL monitors, events, actions and fields for the current file in the Outline view.
  • Showing all top-level EPL symbols (events, actions, monitors etc), with filtering by typing its name. For example press Ctrl+T and begin typing the name of any action or event in the current workspace and you can quickly jump to the line and position where it is defined in the editor.

For more information and instructions for getting started, go to Apama Extension for Visual Studio Code.

In order to use the extension you will need to create an Apama project using the apama_project tool.

Please note that this extension, while useful, is a community offering and is not part of the supported product. There are some known limitations, including incorrect column positions for files that use non-ASCII characters.

“Visual Studio Code” and “VS Code” are trademarks of Microsoft Corporation. All rights reserved.